/*
 * Copyright 2007-2008 Andrew O'Malley
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package ws.quokka.plugin.help;

import ws.quokka.core.repo_spi.RepoArtifact;
import ws.quokka.core.util.xml.Document;
import ws.quokka.core.util.xml.Element;

import java.io.File;


/**
 *
 */
public interface HelpGenerator {
    //~ Methods --------------------------------------------------------------------------------------------------------

    void setSummary(boolean summary);

    void setArtifact(RepoArtifact artifact);

    void setPlugin(HelpPlugin plugin);

    void initialise();

    void addContent(Document outDoc);

    void addSummary(Element el, boolean first, boolean last);

    boolean isUpToDate(File out);
}
